
<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
   <head>
      <meta charset="utf-8"></meta>
      <meta name="viewport" content="width=device-width, initial-scale=1.0"></meta>
      <title>Chapter&nbsp;5.&nbsp;Configuration Options - APOC User Guide 3.4</title>
      <link rel="stylesheet" type="text/css" href="../docbook.css"></link>
      <link rel="stylesheet" type="text/css" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css"></link>
      <link rel="stylesheet" type="text/css" href="//cdn.datatables.net/1.10.13/css/jquery.dataTables.min.css"></link>
      <link rel="stylesheet" type="text/css" href="//cdnjs.cloudflare.com/ajax/libs/font-awesome/4.1.0/css/font-awesome.min.css"></link>
      <link rel="stylesheet" type="text/css" href="//fonts.googleapis.com/css?family=Open+Sans:400,300,400italic,600,300italic"></link>
      <link rel="stylesheet" type="text/css" href="//cdnjs.cloudflare.com/ajax/libs/codemirror/5.11.0/codemirror.min.css"></link>
      <link rel="stylesheet" type="text/css" href="//cdnjs.cloudflare.com/ajax/libs/codemirror/5.11.0/theme/neo.min.css"></link>
      <link rel="stylesheet" type="text/css" href="../css/chunked-base.css"></link>
      <link rel="stylesheet" type="text/css" href="../css/extra.css"></link><script src="//code.jquery.com/jquery-1.12.4.js" type="text/javascript"></script><script src="//cdn.datatables.net/1.10.13/js/jquery.dataTables.min.js" type="text/javascript"></script><script src="//maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js" type="text/javascript"></script><script src="//cdnjs.cloudflare.com/ajax/libs/codemirror/5.11.0/codemirror.min.js" type="text/javascript"></script><script src="//cdnjs.cloudflare.com/ajax/libs/codemirror/5.11.0/addon/runmode/runmode.min.js" type="text/javascript"></script><script src="//cdnjs.cloudflare.com/ajax/libs/codemirror/5.11.0/mode/cypher/cypher.min.js" type="text/javascript"></script><script src="../javascript/datatable.js" type="text/javascript"></script><script src="../javascript/colorize.js" type="text/javascript"></script><script src="../javascript/tabs-for-chunked.js" type="text/javascript"></script><script src="../javascript/mp-nav.js" type="text/javascript"></script><script src="../javascript/versionswitcher.js" type="text/javascript"></script><script src="../javascript/version.js" type="text/javascript"></script><script src="//s3-eu-west-1.amazonaws.com/alpha.neohq.net/docs/new-manual/assets/search.js" type="text/javascript"></script><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"></meta>
      <link rel="prev" href="../installation/" title="Chapter&nbsp;3.&nbsp;Installation in Neo4j Server &amp; Docker"></link>
      <link rel="next" href="../overview/" title="Chapter&nbsp;4.&nbsp;Overview of APOC Procedures &amp; Functions"></link>
      <link rel="shortcut icon" href="https://neo4j.com/wp-content/themes/neo4jweb/favicon.ico"></link><script>
        $(document).ready(function() {
          CodeMirror.colorize();
          tabTheSource($('body'));
          var $header = $('header').first();
          $header.prepend(
            $('<a href="" id="logo"><img src="https://neo4j.com/wp-content/themes/neo4jweb/assets/images/neo4j-logo-2015.png" alt="Neo4j Logo"></img></a>')
          );
          var $sidebar = $('<div id="sidebar-wrapper"></div>');
          $.get('toc.html', function (d){
            $(d).appendTo($sidebar);
            highlightToc();
            highlightLibraryHeader();
          });
          $sidebar.insertAfter($('header').first());
        });
        </script></head>
   <body>
      <header>
         <div class="searchbox">
            <form id="search-form" class="search" name="search-form" role="search"><input id="search-form-input" name="q" title="search" type="search" lang="en" placeholder="Search Neo4j docs..." aria-label="Search Neo4j documentation" max-length="128" required="required"></input><input id="search-form-button" type="submit" value="Search"></input></form>
         </div>
         <ul class="documentation-library">
            <li><a href="https://neo4j.com/docs/operations-manual/current">Operations Manual</a></li>
            <li><a href="https://neo4j.com/docs/developer-manual/current/">Developer Manual</a></li>
            <li><a href="https://neo4j.com/docs/ogm-manual/current/">OGM Manual</a></li>
            <li><a href="https://neo4j.com/docs/graph-algorithms/current/">Graph Algorithms</a></li>
            <li><a href="https://neo4j-contrib.github.io/neo4j-apoc-procedures/3.4/">APOC</a></li>
            <li><a href="https://neo4j.com/docs/java-reference/current/">Java Reference</a></li>
         </ul>
         <nav id="header-nav"><span class="nav-previous"><a accesskey="p" href="../installation/"><span class="fa fa-long-arrow-left" aria-hidden="true"></span>Installation in Neo4j Server &amp; Docker</a></span><span class="nav-current">
               <p class="nav-title hidden">Chapter&nbsp;5.&nbsp;Configuration Options</p></span><span class="nav-next"><a accesskey="n" href="../overview/">Overview of APOC Procedures &amp; Functions<span class="fa fa-long-arrow-right" aria-hidden="true"></span></a></span></nav>
      </header>
      <div id="search-results" class="hidden"></div>
      <section class="chapter" id="config">
         <div class="titlepage">
            <div>
               <div>
                  <h1 class="title">Chapter&nbsp;5.&nbsp;Configuration Options</h1>
               </div>
            </div>
         </div>
         <p>Set these config options in <code class="literal">$NEO4J_HOME/neo4j.conf</code></p>
         <p>All boolean options have default value set to <span class="strong"><strong>false</strong></span>. This means that they are <span class="strong"><strong>disabled</strong></span>, unless mentioned otherwise.
         </p>
         <div class="informaltable">
            <div class="table" id="d0e5624">
               <table class="informaltable" border="1">
                  <colgroup>
                     <col class="col_1"></col>
                     <col class="col_2"></col>
                  </colgroup>
                  <tbody>
                     <tr>
                        <td style="text-align: left; vertical-align: top; ">
                           <p><code class="literal">apoc.trigger.enabled=false/true</code></p>
                        </td>
                        <td style="text-align: left; vertical-align: top; ">
                           <p>Enable triggers</p>
                        </td>
                     </tr>
                     <tr>
                        <td style="text-align: left; vertical-align: top; ">
                           <p><code class="literal">apoc.ttl.enabled=false/true</code></p>
                        </td>
                        <td style="text-align: left; vertical-align: top; ">
                           <p>Enable time to live background task</p>
                        </td>
                     </tr>
                     <tr>
                        <td style="text-align: left; vertical-align: top; ">
                           <p><code class="literal">apoc.ttl.schedule=5 (default <code class="literal">60</code>)</code></p>
                        </td>
                        <td style="text-align: left; vertical-align: top; ">
                           <p>Set frequency in seconds to run ttl background task</p>
                        </td>
                     </tr>
                     <tr>
                        <td style="text-align: left; vertical-align: top; ">
                           <p><code class="literal">apoc.import.file.use_neo4j_config=true/false (default <code class="literal">true</code>)</code></p>
                        </td>
                        <td style="text-align: left; vertical-align: top; ">
                           <p>the procedures check whether file system access is
                              allowed and possibly constrained to a specific directory by reading the two configuration parameters
                              <code class="literal">dbms.security.allow_csv_import_from_file_urls</code> and <code class="literal">dbms.directories.import</code> respectively
                           </p>
                        </td>
                     </tr>
                     <tr>
                        <td style="text-align: left; vertical-align: top; ">
                           <p><code class="literal">apoc.import.file.enabled=false/true</code></p>
                        </td>
                        <td style="text-align: left; vertical-align: top; ">
                           <p>Enable reading local files from disk</p>
                        </td>
                     </tr>
                     <tr>
                        <td style="text-align: left; vertical-align: top; ">
                           <p><code class="literal">apoc.export.file.enabled=false/true</code></p>
                        </td>
                        <td style="text-align: left; vertical-align: top; ">
                           <p>Enable writing local files to disk</p>
                        </td>
                     </tr>
                     <tr>
                        <td style="text-align: left; vertical-align: top; ">
                           <p><code class="literal">apoc.jdbc.&lt;key&gt;.uri=jdbc-url-with-credentials</code></p>
                        </td>
                        <td style="text-align: left; vertical-align: top; ">
                           <p>store jdbc-urls under a key to be used by apoc.load.jdbc</p>
                        </td>
                     </tr>
                     <tr>
                        <td style="text-align: left; vertical-align: top; ">
                           <p><code class="literal">apoc.es.&lt;key&gt;.uri=es-url-with-credentials</code></p>
                        </td>
                        <td style="text-align: left; vertical-align: top; ">
                           <p>store es-urls under a key to be used by elasticsearch procedures</p>
                        </td>
                     </tr>
                     <tr>
                        <td style="text-align: left; vertical-align: top; ">
                           <p><code class="literal">apoc.mongodb.&lt;key&gt;.uri=mongodb-url-with-credentials</code></p>
                        </td>
                        <td style="text-align: left; vertical-align: top; ">
                           <p>store mongodb-urls under a key to be used by mongodb procedures</p>
                        </td>
                     </tr>
                     <tr>
                        <td style="text-align: left; vertical-align: top; ">
                           <p><code class="literal">apoc.couchbase.&lt;key&gt;.uri=couchbase-url-with-credentials</code></p>
                        </td>
                        <td style="text-align: left; vertical-align: top; ">
                           <p>store couchbase-urls under a key to be used by couchbase
                              procedures
                           </p>
                        </td>
                     </tr>
                     <tr>
                        <td style="text-align: left; vertical-align: top; ">
                           <p><code class="literal">apoc.jobs.scheduled.num_threads=number-of-threads</code></p>
                        </td>
                        <td style="text-align: left; vertical-align: top; ">
                           <p>Many periodic procedures rely on a scheduled executor that has
                              a pool of threads with a default fixed size. You can configure the pool size using this configuration property
                           </p>
                        </td>
                     </tr>
                     <tr>
                        <td style="text-align: left; vertical-align: top; ">
                           <p><code class="literal">apoc.jobs.pool.num_threads=number-of-threads</code></p>
                        </td>
                        <td style="text-align: left; vertical-align: top; ">
                           <p>Number of threads in the default APOC thread pool used for background
                              executions.
                           </p>
                        </td>
                     </tr>
                  </tbody>
               </table>
            </div>
         </div>
      </section>
      <footer><script type="text/javascript">
          (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
            (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
          m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
          })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
          //Allow Linker
          ga('create', 'UA-1192232-34','auto', {'allowLinker': true});
          ga('send', 'pageview');
          // Load the plugin.
          ga('require', 'linker');
          // Define which domains to autoLink.
          ga('linker:autoLink', ['neo4j.org','neo4j.com','neotechnology.com','graphdatabases.com','graphconnect.com']);
        </script><script type="text/javascript">
          document.write(unescape("%3Cscript src='//munchkin.marketo.net/munchkin.js' type='text/javascript'%3E%3C/script%3E"));
        </script><script>Munchkin.init('773-GON-065');</script></footer>
   </body>
</html>